The tables below are a summary of the attributes defined by Apis Hive, which may be applied to any item in Apis Hive.
Some Apis Hive attributes have enumerated values, e.g. you may select between a predefined list of attribute values. Check the list of enumerated values and matching integers to get an overview of these attributes.
Handle of an item - used when persisting the runtime state.
4 byte integer
5001
TypeID
The type ID of an item.
4 byte integer
5003
ItemID
The name of the item.
string
5002
InitValue
The initial value of an item.
-
5045
InitValueQuality
Initial value quality of an item (only valid when having an InitValue).
-
5046
InitValueTimestamp
Initial value timestamp of an item (only valid when having an InitValue).
-
5047
InitVQTFromHoneystore
If true, the initial value, quality and timestamp will be fetched from the last logged sample in Apis Honeystore.Note! To successfully use this attribute, the item in question must be logged to Honeystore by an ApisLoggerBee module.
An indication of the maximum length of the value of a string item. Must be used when logging string items to the Apis Honeystore historian, to control how many characters will be stored for each sample.
4 byte integer
5071
MaxCacheDuration
When the item are logged to Apis Honeystore, the maximum duration in seconds, for the item cache when the item is logged by ApisLoggerBee!
4 byte unsigned integer
5080
LowerBound
LBound, The lower bound of items in vector
4 byte real
5081
UpperBound
UBound, The upper bound of items in vector
4 byte real
5090
RowNames
The names of the rows in a vector or matrix, separated by ';'
array of strings
5091
ColNames
The names of the columns in a matrix, separated by ';'
array of strings
5100
ArgumentItem
An item whose value is used to calculate this item
string
5105
FormatString
A general purpose format string, used when applying string formatting to calculate the value of this item.
string
5110
Expression
An expression used to calculate the value of this item
string
5111
Expressions
An array of expressions used to calculate the value of this item
array of string
5130
Rate
An attribute which keeps the value rate
8 byte unsigned integer
5135
Horizon
An attribute which keeps the value horizon
8 byte unsigned integer
5220
Coefficients
Vector of coefficients used for calculation purposes
Severity of alarm associated with this item (according to OPC AE). 1 is the lowest, while 1000 is the highest.
4 byte integer
5610
AlmSeverityList
Severity of alarm associated with this item (according to OPC AE). 1 to 1000 as the allowable range.
string
5630
AlmNormalState
The normal state of a discrete alarm/event (according to OPC AE) associated with this item. A deviation from this value will generate a discrete event.
Variant
5635
AlmActiveDelayPeriods
The number of periods an item is active before an alarm is raised.
2 byte integer
5640
AlmWatchdogPeriods
The max number of periods this item can have the same value before a watchdog alarm is raised.
2 byte integer
5650
AlmInhibitItem
The Item ID of another item whose value will be used to inhibit this alarm if set to true. Changed from a string to a 4 byte unsigned integer at start-up, i.e. 4 byte unsigned integer runtime
string
5652
AlmInhibitOffDelay
The time in milliseconds the alarm inhibit state is delayed before going off
4 byte integer
5653
AlmResetItem
The Item ID of another item, whose value (when true) will reset the alarm of the source when it is inhibitted
The method that decides which data validation tests to use. See "Data Validation Method".
2 byte unsigned integer
5672
DvHiRange
The high limit for a DV range check
8 byte real
5673
DvLoRange
The low limit for a DV range check
8 byte real
5674
DvMaxRoc
The maximum rate of change for a DV rate of change check
8 byte real
5676
DvWdTime
The time limit in seconds for a DV watchdog check
8 byte real
5677
DvCompareItem
The comperand item to use when using any of the difference data-validation methods, ie. The difference is calculated by subtracting the value of the item referenced from the value of the item owning this attribute.
string
5678
DvCompareValue
The compare-value to use when using any of the difference data-validation methods. i.e. If the difference is bigger than the value of this attribute, the data is invalid.
8 byte real
5680
DvSPCUCL
The upper control limit in SPC
8 byte real
5681
DvSPCLCL
The lower control limit in SPC
8 byte real
5682
DvSPCTest
The value assigned causes tests to be performed (multiple selects possible)
string
5683
DvSPCUSL
The upper SPC specification limit item reference, specified as an item reference or value directly.
string
5684
DvSPCLSL
The lower SPC specification limit item reference, specified as an item reference or value directly.
string
5685
DvSPCCL
The central line in SPC, specified as an item reference or value directly. If CL is not specified, UCL and LCL will be used to calculate it.
string
5690
DvSubstMethod
This method decides which data validation substitute value to use, see Data Validation Substitution Method.
2 byte unsigned integer
5692
DvAltExtItem
An alternative external item, to fetch a DV substitute value from
string
5695
DvSuppressAlarm
If true (default behaviour), successive DV alarms of same subcondition are suppressed from being notified to the Alarm server of this Hive instance, ie. suppressed from any AE clients and Alarm database. If false, no DV alarms are suppressed.
An enum deciding what kind of metadata to transfer from source to destination external item(s). EngineeringUnit - The EU and Unit attributes are transferred. Description - The Description attribute is transferred. EURange - The High/Low EU attributes are transferred. InstrumentRange - The High/Low Instrument Range attributes are transferred.
4 byte unsigned integer
5970
MonMethod
The method that decides how external items are monitored. See Pulse Monitoring
2 byte unsigned integer
5971
MonTrueValue
This value is set on the monitoring item if the monitoring method is true
Variant
5972
MonFalseValue
This value is set on the monitoring item if the monitoring method is false
Variant
5980
ExtTransferCtrlMethod
The control method that decides when external items are transferred. See "External Item Data Transfer Control Methods"
2 byte unsigned integer
5982
ExtTransferCtrlItem
The Item ID of another item, whose value will control the transfer of external item values to this item
string
5984
ExtTransferCtrlArgument
The argument to use with the method
string
5986
ExtTransferCtrlInhibitQuality
The quality to set when external item value transfer is inhibited. One of: none=0quality: bad=65536quality: uncertain=65600quality: good=65728quality: bad:config error=65540quality: bad:not connected=65544quality: bad:device failure=65548quality: bad:sensor failure=65552quality: bad:last known value=65556quality: bad:comm failure=65560quality: bad:out of service=65564quality: bad:waiting for initial data=65568quality: uncertain:last usable=65604quality: uncertain:sensor not accurate=65616quality: uncertain:engineering units exceeded=65620quality: uncertain:sub normal=65624quality: good:local override=65752
4 byte unsigned integer
5990
ExtRowSelect
The vector/matrix row in an external vector/matrix item to copy to this scalar item
2 byte integer
5991
ExtColSelect
The vector/matrix column in an external vector/matrix item to copy to this scalar item
2 byte integer
5994
ExternalItem Filters
One or more item name template(s) to use for connecting many external items. When set not an empty array, this attribute takes control over the external item configuration for its item. This means that upon startup, and when changing this attribute at run-time, an operation is triggered that resolves all matching items and connects them to the as external items. Any existing connections no longer matching the filter(s) are removed. An empty array is ignored, and external items can be configured as if this attribute were not present on the item. To make the ExternalItem Filtersperform better, one should avoid having a wildcard '*' in the first part of the filter, before the first '.' separating the item names from its module name part.
array of string
5998
ExtItemPaddingValue
A padding value to be used when assigning missing external item values to an array item, ie. when assigning a source array item of dim 3 to a target item of dim 5
-
5999
ExtItemOverrideMethod
This attribute decides what method to use when assigning a value from an external item, see external item External Item Override Methods
DEPRECATED! SECS/GEM Collection Event ID for item used as trigger. Values below 1000 are reserved for internal usage, and will be ignored on item attributes.
4 byte unsigned integer
6020
DEPRECATED_GemTIDSnd
DEPRECATED! SECS/GEM Terminal ID for equipment generated text
4 byte unsigned integer
6021
DEPRECATED_GemTIDRcv
DEPRECATED! SECS/GEM Terminal ID for host generated text
4 byte unsigned integer
6030
DEPRECATED_GemALID
DEPRECATED! SECS/GEM Alarm ID of an alarm. Values below 1000 are reserved for internal usage, and will be ignored on item attributes.
4 byte unsigned integer
6031
DEPRECATED_GemALCEIDOn
DEPRECATED! SECS/GEM Alarm CEID for an alarm going ON.
4 byte unsigned integer
6032
DEPRECATED_GemALCEIDOff
DEPRECATED! SECS/GEM Alarm CEID for an alarm going OFF.
DEPRECATED! IEC104 TypeID, used by IEC104 server to expose Apis items, enumeration of supported IEC104 TypeIDs:Not in use=0Single point information[Bool]=1Bitstring 32 bits[Int32,UInt32]=7Measured value[Float32]=13